/*
 * Copyright (C) 2011 by Fabien Barbero
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.flickr.api.groups;

import com.flickr.api.FlickrServiceException;
import com.flickr.api.Paginated;

/**
 *
 * @author Fabien Barbero
 */
public interface GroupsService {
    
    /**
     * Get information about a group.
     * @param group                     The group.
     * @return                          The associated informations.
     * @throws FlickrServiceException   Error getting the informations.
     */
    GroupInfo getGroupInfo(Group group) throws FlickrServiceException;
    
    /**
     * Search for groups.
     * 18+ groups will only be returned for authenticated calls where the authenticated user is over 18.
     * @param match                     The text to match.
     * @param perPage                   The number of groups per page.
     * @param page                      The page index.
     * @return                          The groups.
     * @throws FlickrServiceException   Error getting the groups.
     */
    Paginated<Group> searchGroups(String match, int perPage, int page) throws FlickrServiceException;
    
}
